Interface IOpenSearchLowLevelClient

OpenSearch low level client

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public interface IOpenSearchLowLevelClient

Properties

AsynchronousSearch

Asynchronous Search APIs

Declaration

LowLevelAsynchronousSearchNamespace AsynchronousSearch { get; }

Property Value

Type	Description
LowLevelAsynchronousSearchNamespace

Cat

Cat APIs

Declaration

LowLevelCatNamespace Cat { get; }

Property Value

Type	Description
LowLevelCatNamespace

Cluster

Cluster APIs

Declaration

LowLevelClusterNamespace Cluster { get; }

Property Value

Type	Description
LowLevelClusterNamespace

DanglingIndices

Dangling Indices APIs

Declaration

LowLevelDanglingIndicesNamespace DanglingIndices { get; }

Property Value

Type	Description
LowLevelDanglingIndicesNamespace

FlowFramework

Flow Framework APIs

Declaration

LowLevelFlowFrameworkNamespace FlowFramework { get; }

Property Value

Type	Description
LowLevelFlowFrameworkNamespace

Http

Http APIs

Declaration

LowLevelHttpNamespace Http { get; }

Property Value

Type	Description
LowLevelHttpNamespace

Indices

Indices APIs

Declaration

LowLevelIndicesNamespace Indices { get; }

Property Value

Type	Description
LowLevelIndicesNamespace

Ingest

Ingest APIs

Declaration

LowLevelIngestNamespace Ingest { get; }

Property Value

Type	Description
LowLevelIngestNamespace

Insights

Insights APIs

Declaration

LowLevelInsightsNamespace Insights { get; }

Property Value

Type	Description
LowLevelInsightsNamespace

Ism

Ism APIs

Declaration

LowLevelIsmNamespace Ism { get; }

Property Value

Type	Description
LowLevelIsmNamespace

Knn

Knn APIs

Declaration

LowLevelKnnNamespace Knn { get; }

Property Value

Type	Description
LowLevelKnnNamespace

List

List APIs

Declaration

LowLevelListNamespace List { get; }

Property Value

Type	Description
LowLevelListNamespace

Ml

Ml APIs

Declaration

LowLevelMlNamespace Ml { get; }

Property Value

Type	Description
LowLevelMlNamespace

Nodes

Nodes APIs

Declaration

LowLevelNodesNamespace Nodes { get; }

Property Value

Type	Description
LowLevelNodesNamespace

Notifications

Notifications APIs

Declaration

LowLevelNotificationsNamespace Notifications { get; }

Property Value

Type	Description
LowLevelNotificationsNamespace

Observability

Observability APIs

Declaration

LowLevelObservabilityNamespace Observability { get; }

Property Value

Type	Description
LowLevelObservabilityNamespace

Ppl

Ppl APIs

Declaration

LowLevelPplNamespace Ppl { get; }

Property Value

Type	Description
LowLevelPplNamespace

Query

Query APIs

Declaration

LowLevelQueryNamespace Query { get; }

Property Value

Type	Description
LowLevelQueryNamespace

RemoteStore

Remote Store APIs

Declaration

LowLevelRemoteStoreNamespace RemoteStore { get; }

Property Value

Type	Description
LowLevelRemoteStoreNamespace

Replication

Replication APIs

Declaration

LowLevelReplicationNamespace Replication { get; }

Property Value

Type	Description
LowLevelReplicationNamespace

Rollups

Rollups APIs

Declaration

LowLevelRollupsNamespace Rollups { get; }

Property Value

Type	Description
LowLevelRollupsNamespace

SearchPipeline

Search Pipeline APIs

Declaration

LowLevelSearchPipelineNamespace SearchPipeline { get; }

Property Value

Type	Description
LowLevelSearchPipelineNamespace

Security

Security APIs

Declaration

LowLevelSecurityNamespace Security { get; }

Property Value

Type	Description
LowLevelSecurityNamespace

Snapshot

Snapshot APIs

Declaration

LowLevelSnapshotNamespace Snapshot { get; }

Property Value

Type	Description
LowLevelSnapshotNamespace

Sql

Sql APIs

Declaration

LowLevelSqlNamespace Sql { get; }

Property Value

Type	Description
LowLevelSqlNamespace

Tasks

Tasks APIs

Declaration

LowLevelTasksNamespace Tasks { get; }

Property Value

Type	Description
LowLevelTasksNamespace

Transforms

Transforms APIs

Declaration

LowLevelTransformsNamespace Transforms { get; }

Property Value

Type	Description
LowLevelTransformsNamespace

Wlm

Wlm APIs

Declaration

LowLevelWlmNamespace Wlm { get; }

Property Value

Type	Description
LowLevelWlmNamespace

Methods

BulkAsync<TResponse>(PostData, BulkRequestParameters, CancellationToken)

POST on /_bulk

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

BulkAsync<TResponse>(string, PostData, BulkRequestParameters, CancellationToken)

POST on /{index}/_bulk

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the data stream, index, or index alias to perform bulk actions on.
PostData	body
BulkRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

BulkStreamAsync<TResponse>(PostData, BulkStreamRequestParameters, CancellationToken)

PUT on /_bulk/stream

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.17.0 or greater.

BulkStreamAsync<TResponse>(string, PostData, BulkStreamRequestParameters, CancellationToken)

PUT on /{index}/_bulk/stream

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the data stream, index, or index alias to perform bulk actions on.
PostData	body
BulkStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.17.0 or greater.

BulkStream<TResponse>(PostData, BulkStreamRequestParameters)

PUT on /_bulk/stream

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

Declaration

TResponse BulkStream<TResponse>(PostData body, BulkStreamRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.17.0 or greater.

BulkStream<TResponse>(string, PostData, BulkStreamRequestParameters)

PUT on /{index}/_bulk/stream

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

Declaration

TResponse BulkStream<TResponse>(string index, PostData body, BulkStreamRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the data stream, index, or index alias to perform bulk actions on.
PostData	body
BulkStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.17.0 or greater.

Bulk<TResponse>(PostData, BulkRequestParameters)

POST on /_bulk

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

Declaration

TResponse Bulk<TResponse>(PostData body, BulkRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Bulk<TResponse>(string, PostData, BulkRequestParameters)

POST on /{index}/_bulk

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

Declaration

TResponse Bulk<TResponse>(string index, PostData body, BulkRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the data stream, index, or index alias to perform bulk actions on.
PostData	body
BulkRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ClearScrollAsync<TResponse>(PostData, ClearScrollRequestParameters, CancellationToken)

DELETE on /_search/scroll

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	Comma-separated list of scroll IDs to clear if none was specified using the scroll_id parameter.
ClearScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ClearScrollAsync<TResponse>(string, PostData, ClearScrollRequestParameters, CancellationToken)

DELETE on /_search/scroll/{scroll_id}

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

Declaration

[Obsolete("Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body.")]
Task<TResponse> ClearScrollAsync<TResponse>(string scrollId, PostData body, ClearScrollRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	scrollId	Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use _all.
PostData	body	Comma-separated list of scroll IDs to clear if none was specified using the scroll_id parameter.
ClearScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ClearScroll<TResponse>(PostData, ClearScrollRequestParameters)

DELETE on /_search/scroll

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

Declaration

TResponse ClearScroll<TResponse>(PostData body, ClearScrollRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Comma-separated list of scroll IDs to clear if none was specified using the scroll_id parameter.
ClearScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ClearScroll<TResponse>(string, PostData, ClearScrollRequestParameters)

DELETE on /_search/scroll/{scroll_id}

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

Declaration

[Obsolete("Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body.")]
TResponse ClearScroll<TResponse>(string scrollId, PostData body, ClearScrollRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	scrollId	Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use _all.
PostData	body	Comma-separated list of scroll IDs to clear if none was specified using the scroll_id parameter.
ClearScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

CountAsync<TResponse>(PostData, CountRequestParameters, CancellationToken)

POST on /_count

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	Query to restrict the results specified with the Query DSL (optional).
CountRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

CountAsync<TResponse>(string, PostData, CountRequestParameters, CancellationToken)

POST on /{index}/_count

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Count<TResponse>(PostData, CountRequestParameters)

POST on /_count

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

Declaration

TResponse Count<TResponse>(PostData body, CountRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Query to restrict the results specified with the Query DSL (optional).
CountRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Count<TResponse>(string, PostData, CountRequestParameters)

POST on /{index}/_count

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

Declaration

TResponse Count<TResponse>(string index, PostData body, CountRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

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

PUT on /{index}/_create/{id}

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (*) pattern of an index template with a data_stream definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index.
string	id	Unique identifier for the document.
PostData	body	The document.
CreateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

CreatePitAsync<TResponse>(string, CreatePitRequestParameters, CancellationToken)

POST on /{index}/_search/point_in_time

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

CreatePit<TResponse>(string, CreatePitRequestParameters)

POST on /{index}/_search/point_in_time

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

Declaration

TResponse CreatePit<TResponse>(string index, CreatePitRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

Create<TResponse>(string, string, PostData, CreateRequestParameters)

PUT on /{index}/_create/{id}

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (*) pattern of an index template with a data_stream definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index.
string	id	Unique identifier for the document.
PostData	body	The document.
CreateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteAllPitsAsync<TResponse>(DeleteAllPitsRequestParameters, CancellationToken)

DELETE on /_search/point_in_time/_all

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

Declaration

Task<TResponse> DeleteAllPitsAsync<TResponse>(DeleteAllPitsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteAllPits<TResponse>(DeleteAllPitsRequestParameters)

DELETE on /_search/point_in_time/_all

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

Declaration

TResponse DeleteAllPits<TResponse>(DeleteAllPitsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteAsync<TResponse>(string, string, DeleteRequestParameters, CancellationToken)

DELETE on /{index}/_doc/{id}

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the target index.
string	id	Unique identifier for the document.
DeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteByQueryAsync<TResponse>(string, PostData, DeleteByQueryRequestParameters, CancellationToken)

POST on /{index}/_delete_by_query

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteByQueryRethrottleAsync<TResponse>(string, DeleteByQueryRethrottleRequestParameters, CancellationToken)

POST on /_delete_by_query/{task_id}/_rethrottle

https://opensearch.org/docs/latest

Declaration

Task<TResponse> DeleteByQueryRethrottleAsync<TResponse>(string taskId, DeleteByQueryRethrottleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The ID for the task.
DeleteByQueryRethrottleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteByQueryRethrottle<TResponse>(string, DeleteByQueryRethrottleRequestParameters)

POST on /_delete_by_query/{task_id}/_rethrottle

https://opensearch.org/docs/latest

Declaration

TResponse DeleteByQueryRethrottle<TResponse>(string taskId, DeleteByQueryRethrottleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The ID for the task.
DeleteByQueryRethrottleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteByQuery<TResponse>(string, PostData, DeleteByQueryRequestParameters)

POST on /{index}/_delete_by_query

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

Declaration

TResponse DeleteByQuery<TResponse>(string index, PostData body, DeleteByQueryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeletePitAsync<TResponse>(PostData, DeletePitRequestParameters, CancellationToken)

DELETE on /_search/point_in_time

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	The point-in-time ids to be deleted.
DeletePitRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeletePit<TResponse>(PostData, DeletePitRequestParameters)

DELETE on /_search/point_in_time

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

Declaration

TResponse DeletePit<TResponse>(PostData body, DeletePitRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The point-in-time ids to be deleted.
DeletePitRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteScriptAsync<TResponse>(string, DeleteScriptRequestParameters, CancellationToken)

DELETE on /_scripts/{id}

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

Declaration

Task<TResponse> DeleteScriptAsync<TResponse>(string id, DeleteScriptRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template.
DeleteScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteScript<TResponse>(string, DeleteScriptRequestParameters)

DELETE on /_scripts/{id}

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

Declaration

TResponse DeleteScript<TResponse>(string id, DeleteScriptRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template.
DeleteScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Delete<TResponse>(string, string, DeleteRequestParameters)

DELETE on /{index}/_doc/{id}

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the target index.
string	id	Unique identifier for the document.
DeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

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

Perform any request you want over the configured IConnection asynchronously while taking advantage of the cluster failover.

Declaration

Task<TResponse> DoRequestAsync<TResponse>(HttpMethod method, string path, CancellationToken cancellationToken, PostData data = null, IRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
HttpMethod	method	the HTTP Method to use
string	path	The path of the the url that you would like to hit
CancellationToken	cancellationToken
PostData	data	The body of the request, string and byte[] are posted as is other types will be serialized to JSON
IRequestParameters	requestParameters	Optionally configure request specific timeouts, headers

Returns

Type	Description
Task<TResponse>	A task of OpenSearchResponse of T where T represents the JSON response body

Type Parameters

Name	Description
TResponse	The type representing the response JSON

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

Perform any request you want over the configured IConnection synchronously while taking advantage of the cluster failover.

Declaration

TResponse DoRequest<TResponse>(HttpMethod method, string path, PostData data = null, IRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
HttpMethod	method	the HTTP Method to use
string	path	The path of the the url that you would like to hit
PostData	data	The body of the request, string and byte[] are posted as is other types will be serialized to JSON
IRequestParameters	requestParameters	Optionally configure request specific timeouts, headers

Returns

Type	Description
TResponse	An OpenSearchResponse of T where T represents the JSON response body

Type Parameters

Name	Description
TResponse	The type representing the response JSON

DocumentExistsAsync<TResponse>(string, string, DocumentExistsRequestParameters, CancellationToken)

HEAD on /{index}/_doc/{id}

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

Declaration

Task<TResponse> DocumentExistsAsync<TResponse>(string index, string id, DocumentExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DocumentExists<TResponse>(string, string, DocumentExistsRequestParameters)

HEAD on /{index}/_doc/{id}

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

Declaration

TResponse DocumentExists<TResponse>(string index, string id, DocumentExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ExecutePainlessScriptAsync<TResponse>(PostData, ExecutePainlessScriptRequestParameters, CancellationToken)

POST on /_scripts/painless/_execute

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	The script to execute.
ExecutePainlessScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ExecutePainlessScript<TResponse>(PostData, ExecutePainlessScriptRequestParameters)

POST on /_scripts/painless/_execute

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

Declaration

TResponse ExecutePainlessScript<TResponse>(PostData body, ExecutePainlessScriptRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The script to execute.
ExecutePainlessScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ExplainAsync<TResponse>(string, string, PostData, ExplainRequestParameters, CancellationToken)

POST on /{index}/_explain/{id}

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

Declaration

Task<TResponse> ExplainAsync<TResponse>(string index, string id, PostData body, ExplainRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index names used to limit the request. Only a single index name can be provided to this parameter.
string	id	Defines the document ID.
PostData	body	The query definition using the Query DSL.
ExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Explain<TResponse>(string, string, PostData, ExplainRequestParameters)

POST on /{index}/_explain/{id}

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

Declaration

TResponse Explain<TResponse>(string index, string id, PostData body, ExplainRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index names used to limit the request. Only a single index name can be provided to this parameter.
string	id	Defines the document ID.
PostData	body	The query definition using the Query DSL.
ExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

FieldCapabilitiesAsync<TResponse>(FieldCapabilitiesRequestParameters, CancellationToken)

POST on /_field_caps

Declaration

Task<TResponse> FieldCapabilitiesAsync<TResponse>(FieldCapabilitiesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

FieldCapabilitiesAsync<TResponse>(PostData, FieldCapabilitiesRequestParameters, CancellationToken)

POST on /_field_caps

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	An index filter specified with the Query DSL.
FieldCapabilitiesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

FieldCapabilitiesAsync<TResponse>(string, FieldCapabilitiesRequestParameters, CancellationToken)

POST on /{index}/_field_caps

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

FieldCapabilitiesAsync<TResponse>(string, PostData, FieldCapabilitiesRequestParameters, CancellationToken)

POST on /{index}/_field_caps

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

FieldCapabilities<TResponse>(FieldCapabilitiesRequestParameters)

POST on /_field_caps

Declaration

TResponse FieldCapabilities<TResponse>(FieldCapabilitiesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

FieldCapabilities<TResponse>(PostData, FieldCapabilitiesRequestParameters)

POST on /_field_caps

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

Declaration

TResponse FieldCapabilities<TResponse>(PostData body, FieldCapabilitiesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	An index filter specified with the Query DSL.
FieldCapabilitiesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

FieldCapabilities<TResponse>(string, FieldCapabilitiesRequestParameters)

POST on /{index}/_field_caps

Declaration

TResponse FieldCapabilities<TResponse>(string index, FieldCapabilitiesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

FieldCapabilities<TResponse>(string, PostData, FieldCapabilitiesRequestParameters)

POST on /{index}/_field_caps

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

Declaration

TResponse FieldCapabilities<TResponse>(string index, PostData body, FieldCapabilitiesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAllPitsAsync<TResponse>(GetAllPitsRequestParameters, CancellationToken)

GET on /_search/point_in_time/_all

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

Declaration

Task<TResponse> GetAllPitsAsync<TResponse>(GetAllPitsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetAllPits<TResponse>(GetAllPitsRequestParameters)

GET on /_search/point_in_time/_all

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

Declaration

TResponse GetAllPits<TResponse>(GetAllPitsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetAsync<TResponse>(string, string, GetRequestParameters, CancellationToken)

GET on /{index}/_doc/{id}

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
string	id	Unique identifier of the document.
GetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetScriptAsync<TResponse>(string, GetScriptRequestParameters, CancellationToken)

GET on /_scripts/{id}

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

Declaration

Task<TResponse> GetScriptAsync<TResponse>(string id, GetScriptRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template.
GetScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetScriptContextAsync<TResponse>(GetScriptContextRequestParameters, CancellationToken)

GET on /_script_context

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

Declaration

Task<TResponse> GetScriptContextAsync<TResponse>(GetScriptContextRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetScriptContext<TResponse>(GetScriptContextRequestParameters)

GET on /_script_context

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

Declaration

TResponse GetScriptContext<TResponse>(GetScriptContextRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetScriptLanguagesAsync<TResponse>(GetScriptLanguagesRequestParameters, CancellationToken)

GET on /_script_language

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

Declaration

Task<TResponse> GetScriptLanguagesAsync<TResponse>(GetScriptLanguagesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetScriptLanguages<TResponse>(GetScriptLanguagesRequestParameters)

GET on /_script_language

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

Declaration

TResponse GetScriptLanguages<TResponse>(GetScriptLanguagesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetScript<TResponse>(string, GetScriptRequestParameters)

GET on /_scripts/{id}

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

Declaration

TResponse GetScript<TResponse>(string id, GetScriptRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template.
GetScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Get<TResponse>(string, string, GetRequestParameters)

GET on /{index}/_doc/{id}

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
string	id	Unique identifier of the document.
GetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

IndexAsync<TResponse>(string, PostData, IndexRequestParameters, CancellationToken)

POST on /{index}/_doc

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the data stream or index to target.
PostData	body	The document.
IndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

IndexAsync<TResponse>(string, string, PostData, IndexRequestParameters, CancellationToken)

PUT on /{index}/_doc/{id}

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

Declaration

Task<TResponse> IndexAsync<TResponse>(string index, string id, PostData body, IndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the data stream or index to target.
string	id	Unique identifier for the document.
PostData	body	The document.
IndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Index<TResponse>(string, PostData, IndexRequestParameters)

POST on /{index}/_doc

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

Declaration

TResponse Index<TResponse>(string index, PostData body, IndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the data stream or index to target.
PostData	body	The document.
IndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Index<TResponse>(string, string, PostData, IndexRequestParameters)

PUT on /{index}/_doc/{id}

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

Declaration

TResponse Index<TResponse>(string index, string id, PostData body, IndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the data stream or index to target.
string	id	Unique identifier for the document.
PostData	body	The document.
IndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiGetAsync<TResponse>(PostData, MultiGetRequestParameters, CancellationToken)

POST on /_mget

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	Document identifiers; can be either docs (containing full document information) or ids (when index is provided in the URL.
MultiGetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiGetAsync<TResponse>(string, PostData, MultiGetRequestParameters, CancellationToken)

POST on /{index}/_mget

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

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the index to retrieve documents from when ids are specified, or when a document in the docs array does not specify an index.
PostData	body	Document identifiers; can be either docs (containing full document information) or ids (when index is provided in the URL.
MultiGetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiGet<TResponse>(PostData, MultiGetRequestParameters)

POST on /_mget

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

Declaration

TResponse MultiGet<TResponse>(PostData body, MultiGetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Document identifiers; can be either docs (containing full document information) or ids (when index is provided in the URL.
MultiGetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiGet<TResponse>(string, PostData, MultiGetRequestParameters)

POST on /{index}/_mget

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

Declaration

TResponse MultiGet<TResponse>(string index, PostData body, MultiGetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index to retrieve documents from when ids are specified, or when a document in the docs array does not specify an index.
PostData	body	Document identifiers; can be either docs (containing full document information) or ids (when index is provided in the URL.
MultiGetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiSearchAsync<TResponse>(PostData, MultiSearchRequestParameters, CancellationToken)

POST on /_msearch

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiSearchAsync<TResponse>(string, PostData, MultiSearchRequestParameters, CancellationToken)

POST on /{index}/_msearch

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

Declaration

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

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and index aliases to search.
PostData	body
MultiSearchRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiSearchTemplateAsync<TResponse>(PostData, MultiSearchTemplateRequestParameters, CancellationToken)

POST on /_msearch/template

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiSearchTemplateAsync<TResponse>(string, PostData, MultiSearchTemplateRequestParameters, CancellationToken)

POST on /{index}/_msearch/template

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiSearchTemplate<TResponse>(PostData, MultiSearchTemplateRequestParameters)

POST on /_msearch/template

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

Declaration

TResponse MultiSearchTemplate<TResponse>(PostData body, MultiSearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiSearchTemplate<TResponse>(string, PostData, MultiSearchTemplateRequestParameters)

POST on /{index}/_msearch/template

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

Declaration

TResponse MultiSearchTemplate<TResponse>(string index, PostData body, MultiSearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiSearch<TResponse>(PostData, MultiSearchRequestParameters)

POST on /_msearch

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

Declaration

TResponse MultiSearch<TResponse>(PostData body, MultiSearchRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiSearch<TResponse>(string, PostData, MultiSearchRequestParameters)

POST on /{index}/_msearch

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

Declaration

TResponse MultiSearch<TResponse>(string index, PostData body, MultiSearchRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and index aliases to search.
PostData	body
MultiSearchRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiTermVectorsAsync<TResponse>(PostData, MultiTermVectorsRequestParameters, CancellationToken)

POST on /_mtermvectors

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
PostData	body	Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
MultiTermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiTermVectorsAsync<TResponse>(string, PostData, MultiTermVectorsRequestParameters, CancellationToken)

POST on /{index}/_mtermvectors

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the index that contains the documents.
PostData	body	Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
MultiTermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

MultiTermVectors<TResponse>(PostData, MultiTermVectorsRequestParameters)

POST on /_mtermvectors

https://opensearch.org/docs/latest

Declaration

TResponse MultiTermVectors<TResponse>(PostData body, MultiTermVectorsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
MultiTermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MultiTermVectors<TResponse>(string, PostData, MultiTermVectorsRequestParameters)

POST on /{index}/_mtermvectors

https://opensearch.org/docs/latest

Declaration

TResponse MultiTermVectors<TResponse>(string index, PostData body, MultiTermVectorsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index that contains the documents.
PostData	body	Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
MultiTermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PingAsync<TResponse>(PingRequestParameters, CancellationToken)

HEAD on /

https://opensearch.org/docs/latest

Declaration

Task<TResponse> PingAsync<TResponse>(PingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Ping<TResponse>(PingRequestParameters)

HEAD on /

https://opensearch.org/docs/latest

Declaration

TResponse Ping<TResponse>(PingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutScriptAsync<TResponse>(string, PostData, PutScriptRequestParameters, CancellationToken)

PUT on /_scripts/{id}

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

Declaration

Task<TResponse> PutScriptAsync<TResponse>(string id, PostData body, PutScriptRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template. Must be unique within the cluster.
PostData	body	The document.
PutScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutScriptAsync<TResponse>(string, string, PostData, PutScriptRequestParameters, CancellationToken)

PUT on /_scripts/{id}/{context}

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

Declaration

Task<TResponse> PutScriptAsync<TResponse>(string id, string context, PostData body, PutScriptRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template. Must be unique within the cluster.
string	context	Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.
PostData	body	The document.
PutScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutScript<TResponse>(string, PostData, PutScriptRequestParameters)

PUT on /_scripts/{id}

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

Declaration

TResponse PutScript<TResponse>(string id, PostData body, PutScriptRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template. Must be unique within the cluster.
PostData	body	The document.
PutScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutScript<TResponse>(string, string, PostData, PutScriptRequestParameters)

PUT on /_scripts/{id}/{context}

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

Declaration

TResponse PutScript<TResponse>(string id, string context, PostData body, PutScriptRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Identifier for the stored script or search template. Must be unique within the cluster.
string	context	Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.
PostData	body	The document.
PutScriptRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RankEvalAsync<TResponse>(PostData, RankEvalRequestParameters, CancellationToken)

POST on /_rank_eval

https://opensearch.org/docs/latest/api-reference/rank-eval/

Declaration

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

Parameters

Type	Name	Description
PostData	body	The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
RankEvalRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RankEvalAsync<TResponse>(string, PostData, RankEvalRequestParameters, CancellationToken)

POST on /{index}/_rank_eval

https://opensearch.org/docs/latest/api-reference/rank-eval/

Declaration

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

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use _all or *.
PostData	body	The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
RankEvalRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RankEval<TResponse>(PostData, RankEvalRequestParameters)

POST on /_rank_eval

https://opensearch.org/docs/latest/api-reference/rank-eval/

Declaration

TResponse RankEval<TResponse>(PostData body, RankEvalRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
RankEvalRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RankEval<TResponse>(string, PostData, RankEvalRequestParameters)

POST on /{index}/_rank_eval

https://opensearch.org/docs/latest/api-reference/rank-eval/

Declaration

TResponse RankEval<TResponse>(string index, PostData body, RankEvalRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use _all or *.
PostData	body	The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
RankEvalRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ReindexOnServerAsync<TResponse>(PostData, ReindexOnServerRequestParameters, CancellationToken)

POST on /_reindex

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	The search definition using the Query DSL and the prototype for the index request.
ReindexOnServerRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ReindexOnServer<TResponse>(PostData, ReindexOnServerRequestParameters)

POST on /_reindex

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

Declaration

TResponse ReindexOnServer<TResponse>(PostData body, ReindexOnServerRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The search definition using the Query DSL and the prototype for the index request.
ReindexOnServerRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ReindexRethrottleAsync<TResponse>(string, ReindexRethrottleRequestParameters, CancellationToken)

POST on /_reindex/{task_id}/_rethrottle

https://opensearch.org/docs/latest

Declaration

Task<TResponse> ReindexRethrottleAsync<TResponse>(string taskId, ReindexRethrottleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	Identifier for the task.
ReindexRethrottleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ReindexRethrottle<TResponse>(string, ReindexRethrottleRequestParameters)

POST on /_reindex/{task_id}/_rethrottle

https://opensearch.org/docs/latest

Declaration

TResponse ReindexRethrottle<TResponse>(string taskId, ReindexRethrottleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	Identifier for the task.
ReindexRethrottleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RenderSearchTemplateAsync<TResponse>(PostData, RenderSearchTemplateRequestParameters, CancellationToken)

POST on /_render/template

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	The search definition template and its parameters.
RenderSearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RenderSearchTemplateAsync<TResponse>(string, PostData, RenderSearchTemplateRequestParameters, CancellationToken)

POST on /_render/template/{id}

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

Declaration

Task<TResponse> RenderSearchTemplateAsync<TResponse>(string id, PostData body, RenderSearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	ID of the search template to render. If no source is specified, this or the id request body parameter is required.
PostData	body	The search definition template and its parameters.
RenderSearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RenderSearchTemplate<TResponse>(PostData, RenderSearchTemplateRequestParameters)

POST on /_render/template

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

Declaration

TResponse RenderSearchTemplate<TResponse>(PostData body, RenderSearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The search definition template and its parameters.
RenderSearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RenderSearchTemplate<TResponse>(string, PostData, RenderSearchTemplateRequestParameters)

POST on /_render/template/{id}

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

Declaration

TResponse RenderSearchTemplate<TResponse>(string id, PostData body, RenderSearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	ID of the search template to render. If no source is specified, this or the id request body parameter is required.
PostData	body	The search definition template and its parameters.
RenderSearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RootNodeInfoAsync<TResponse>(RootNodeInfoRequestParameters, CancellationToken)

GET on /

https://opensearch.org/docs/latest

Declaration

Task<TResponse> RootNodeInfoAsync<TResponse>(RootNodeInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RootNodeInfo<TResponse>(RootNodeInfoRequestParameters)

GET on /

https://opensearch.org/docs/latest

Declaration

TResponse RootNodeInfo<TResponse>(RootNodeInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ScrollAsync<TResponse>(PostData, ScrollRequestParameters, CancellationToken)

POST on /_search/scroll

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	The scroll ID if not passed by URL or query parameter.
ScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ScrollAsync<TResponse>(string, PostData, ScrollRequestParameters, CancellationToken)

POST on /_search/scroll/{scroll_id}

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

Declaration

[Obsolete("Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body.")]
Task<TResponse> ScrollAsync<TResponse>(string scrollId, PostData body, ScrollRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	scrollId	The scroll ID.
PostData	body	The scroll ID if not passed by URL or query parameter.
ScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Scroll<TResponse>(PostData, ScrollRequestParameters)

POST on /_search/scroll

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

Declaration

TResponse Scroll<TResponse>(PostData body, ScrollRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The scroll ID if not passed by URL or query parameter.
ScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Scroll<TResponse>(string, PostData, ScrollRequestParameters)

POST on /_search/scroll/{scroll_id}

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

Declaration

[Obsolete("Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body.")]
TResponse Scroll<TResponse>(string scrollId, PostData body, ScrollRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	scrollId	The scroll ID.
PostData	body	The scroll ID if not passed by URL or query parameter.
ScrollRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SearchAsync<TResponse>(PostData, SearchRequestParameters, CancellationToken)

POST on /_search

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	The search definition using the Query DSL.
SearchRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SearchAsync<TResponse>(string, PostData, SearchRequestParameters, CancellationToken)

POST on /{index}/_search

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SearchShardsAsync<TResponse>(SearchShardsRequestParameters, CancellationToken)

POST on /_search_shards

https://opensearch.org/docs/latest

Declaration

Task<TResponse> SearchShardsAsync<TResponse>(SearchShardsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SearchShardsAsync<TResponse>(string, SearchShardsRequestParameters, CancellationToken)

POST on /{index}/_search_shards

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
string	index	Returns the indexes and shards that a search request would be executed against.
SearchShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SearchShards<TResponse>(SearchShardsRequestParameters)

POST on /_search_shards

https://opensearch.org/docs/latest

Declaration

TResponse SearchShards<TResponse>(SearchShardsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SearchShards<TResponse>(string, SearchShardsRequestParameters)

POST on /{index}/_search_shards

https://opensearch.org/docs/latest

Declaration

TResponse SearchShards<TResponse>(string index, SearchShardsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Returns the indexes and shards that a search request would be executed against.
SearchShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SearchTemplateAsync<TResponse>(PostData, SearchTemplateRequestParameters, CancellationToken)

POST on /_search/template

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

Declaration

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

Parameters

Type	Name	Description
PostData	body	The search definition template and its parameters.
SearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SearchTemplateAsync<TResponse>(string, PostData, SearchTemplateRequestParameters, CancellationToken)

POST on /{index}/_search/template

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

Declaration

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

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*).
PostData	body	The search definition template and its parameters.
SearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SearchTemplate<TResponse>(PostData, SearchTemplateRequestParameters)

POST on /_search/template

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

Declaration

TResponse SearchTemplate<TResponse>(PostData body, SearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The search definition template and its parameters.
SearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SearchTemplate<TResponse>(string, PostData, SearchTemplateRequestParameters)

POST on /{index}/_search/template

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

Declaration

TResponse SearchTemplate<TResponse>(string index, PostData body, SearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*).
PostData	body	The search definition template and its parameters.
SearchTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Search<TResponse>(PostData, SearchRequestParameters)

POST on /_search

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

Declaration

TResponse Search<TResponse>(PostData body, SearchRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The search definition using the Query DSL.
SearchRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Search<TResponse>(string, PostData, SearchRequestParameters)

POST on /{index}/_search

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

Declaration

TResponse Search<TResponse>(string index, PostData body, SearchRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SourceAsync<TResponse>(string, string, SourceRequestParameters, CancellationToken)

GET on /{index}/_source/{id}

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

Declaration

Task<TResponse> SourceAsync<TResponse>(string index, string id, SourceRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
string	id	Unique identifier of the document.
SourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SourceExistsAsync<TResponse>(string, string, SourceExistsRequestParameters, CancellationToken)

HEAD on /{index}/_source/{id}

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

Declaration

Task<TResponse> SourceExistsAsync<TResponse>(string index, string id, SourceExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SourceExists<TResponse>(string, string, SourceExistsRequestParameters)

HEAD on /{index}/_source/{id}

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

Declaration

TResponse SourceExists<TResponse>(string index, string id, SourceExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Source<TResponse>(string, string, SourceRequestParameters)

GET on /{index}/_source/{id}

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

Declaration

TResponse Source<TResponse>(string index, string id, SourceRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
string	id	Unique identifier of the document.
SourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

TermVectorsAsync<TResponse>(string, PostData, TermVectorsRequestParameters, CancellationToken)

POST on /{index}/_termvectors

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
PostData	body	Define parameters and or supply a document to get termvectors for. See documentation.
TermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

TermVectorsAsync<TResponse>(string, string, PostData, TermVectorsRequestParameters, CancellationToken)

POST on /{index}/_termvectors/{id}

https://opensearch.org/docs/latest

Declaration

Task<TResponse> TermVectorsAsync<TResponse>(string index, string id, PostData body, TermVectorsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
string	id	Unique identifier of the document.
PostData	body	Define parameters and or supply a document to get termvectors for. See documentation.
TermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

TermVectors<TResponse>(string, PostData, TermVectorsRequestParameters)

POST on /{index}/_termvectors

https://opensearch.org/docs/latest

Declaration

TResponse TermVectors<TResponse>(string index, PostData body, TermVectorsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
PostData	body	Define parameters and or supply a document to get termvectors for. See documentation.
TermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

TermVectors<TResponse>(string, string, PostData, TermVectorsRequestParameters)

POST on /{index}/_termvectors/{id}

https://opensearch.org/docs/latest

Declaration

TResponse TermVectors<TResponse>(string index, string id, PostData body, TermVectorsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index that contains the document.
string	id	Unique identifier of the document.
PostData	body	Define parameters and or supply a document to get termvectors for. See documentation.
TermVectorsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

UpdateAsync<TResponse>(string, string, PostData, UpdateRequestParameters, CancellationToken)

POST on /{index}/_update/{id}

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

Declaration

Task<TResponse> UpdateAsync<TResponse>(string index, string id, PostData body, UpdateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	The name of the index.
string	id	Document ID.
PostData	body	The request definition requires either script or partial doc.
UpdateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UpdateByQueryAsync<TResponse>(string, PostData, UpdateByQueryRequestParameters, CancellationToken)

POST on /{index}/_update_by_query

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UpdateByQueryRethrottleAsync<TResponse>(string, UpdateByQueryRethrottleRequestParameters, CancellationToken)

POST on /_update_by_query/{task_id}/_rethrottle

https://opensearch.org/docs/latest

Declaration

Task<TResponse> UpdateByQueryRethrottleAsync<TResponse>(string taskId, UpdateByQueryRethrottleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The ID for the task.
UpdateByQueryRethrottleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UpdateByQueryRethrottle<TResponse>(string, UpdateByQueryRethrottleRequestParameters)

POST on /_update_by_query/{task_id}/_rethrottle

https://opensearch.org/docs/latest

Declaration

TResponse UpdateByQueryRethrottle<TResponse>(string taskId, UpdateByQueryRethrottleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The ID for the task.
UpdateByQueryRethrottleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

UpdateByQuery<TResponse>(string, PostData, UpdateByQueryRequestParameters)

POST on /{index}/_update_by_query

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

Declaration

TResponse UpdateByQuery<TResponse>(string index, PostData body, UpdateByQueryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Update<TResponse>(string, string, PostData, UpdateRequestParameters)

POST on /{index}/_update/{id}

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

Declaration

TResponse Update<TResponse>(string index, string id, PostData body, UpdateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	The name of the index.
string	id	Document ID.
PostData	body	The request definition requires either script or partial doc.
UpdateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)