Class OpenSearchLowLevelClient
Low level client that exposes all of OpenSearch API endpoints but leaves you in charge of building request and handling the response
Implements
Inherited Members
Namespace: OpenSearch .Net
Assembly: OpenSearch.Net.dll
Syntax
public class OpenSearchLowLevelClient : IOpenSearchLowLevelClient
Constructors
| Edit this page View SourceOpenSearchLowLevelClient()
Instantiate a new low level OpenSearch client to http://localhost:9200
Declaration
public OpenSearchLowLevelClient()
OpenSearchLowLevelClient(IConnectionConfigurationValues)
Instantiate a new low level OpenSearch client using the specified settings
Declaration
public OpenSearchLowLevelClient(IConnectionConfigurationValues settings)
Parameters
Type | Name | Description |
---|---|---|
IConnection |
settings |
OpenSearchLowLevelClient(ITransport<IConnectionConfigurationValues>)
Instantiate a new low level OpenSearch client explicitly specifying a custom transport setup
Declaration
public OpenSearchLowLevelClient(ITransport<IConnectionConfigurationValues> transport)
Parameters
Type | Name | Description |
---|---|---|
ITransport<IConnection |
transport |
OpenSearchLowLevelClient(string, ApiKeyAuthenticationCredentials)
Sets up the client to communicate to OpenSearch Cloud using cloudId
,
Cloud
cloudId
in its constructor as well
Declaration
public OpenSearchLowLevelClient(string cloudId, ApiKeyAuthenticationCredentials credentials)
Parameters
Type | Name | Description |
---|---|---|
string | cloudId | |
Api |
credentials |
OpenSearchLowLevelClient(string, BasicAuthenticationCredentials)
Sets up the client to communicate to OpenSearch Cloud using cloudId
,
Cloud
cloudId
in its constructor as well
Declaration
public OpenSearchLowLevelClient(string cloudId, BasicAuthenticationCredentials credentials)
Parameters
Type | Name | Description |
---|---|---|
string | cloudId | |
Basic |
credentials |
Properties
| Edit this page View SourceAsynchronousSearch
Asynchronous Search APIs
Declaration
public LowLevelAsynchronousSearchNamespace AsynchronousSearch { get; }
Property Value
Type | Description |
---|---|
Low |
Cat
Cat APIs
Declaration
public LowLevelCatNamespace Cat { get; }
Property Value
Type | Description |
---|---|
Low |
Cluster
Cluster APIs
Declaration
public LowLevelClusterNamespace Cluster { get; }
Property Value
Type | Description |
---|---|
Low |
DanglingIndices
Dangling Indices APIs
Declaration
public LowLevelDanglingIndicesNamespace DanglingIndices { get; }
Property Value
Type | Description |
---|---|
Low |
FlowFramework
Flow Framework APIs
Declaration
public LowLevelFlowFrameworkNamespace FlowFramework { get; }
Property Value
Type | Description |
---|---|
Low |
Http
Http APIs
Declaration
public LowLevelHttpNamespace Http { get; }
Property Value
Type | Description |
---|---|
Low |
Indices
Indices APIs
Declaration
public LowLevelIndicesNamespace Indices { get; }
Property Value
Type | Description |
---|---|
Low |
Ingest
Ingest APIs
Declaration
public LowLevelIngestNamespace Ingest { get; }
Property Value
Type | Description |
---|---|
Low |
Insights
Insights APIs
Declaration
public LowLevelInsightsNamespace Insights { get; }
Property Value
Type | Description |
---|---|
Low |
Ism
Ism APIs
Declaration
public LowLevelIsmNamespace Ism { get; }
Property Value
Type | Description |
---|---|
Low |
Knn
Knn APIs
Declaration
public LowLevelKnnNamespace Knn { get; }
Property Value
Type | Description |
---|---|
Low |
List
List APIs
Declaration
public LowLevelListNamespace List { get; }
Property Value
Type | Description |
---|---|
Low |
Ml
Ml APIs
Declaration
public LowLevelMlNamespace Ml { get; }
Property Value
Type | Description |
---|---|
Low |
Nodes
Nodes APIs
Declaration
public LowLevelNodesNamespace Nodes { get; }
Property Value
Type | Description |
---|---|
Low |
Notifications
Notifications APIs
Declaration
public LowLevelNotificationsNamespace Notifications { get; }
Property Value
Type | Description |
---|---|
Low |
Observability
Observability APIs
Declaration
public LowLevelObservabilityNamespace Observability { get; }
Property Value
Type | Description |
---|---|
Low |
Ppl
Ppl APIs
Declaration
public LowLevelPplNamespace Ppl { get; }
Property Value
Type | Description |
---|---|
Low |
Query
Query APIs
Declaration
public LowLevelQueryNamespace Query { get; }
Property Value
Type | Description |
---|---|
Low |
RemoteStore
Remote Store APIs
Declaration
public LowLevelRemoteStoreNamespace RemoteStore { get; }
Property Value
Type | Description |
---|---|
Low |
Replication
Replication APIs
Declaration
public LowLevelReplicationNamespace Replication { get; }
Property Value
Type | Description |
---|---|
Low |
Rollups
Rollups APIs
Declaration
public LowLevelRollupsNamespace Rollups { get; }
Property Value
Type | Description |
---|---|
Low |
SearchPipeline
Search Pipeline APIs
Declaration
public LowLevelSearchPipelineNamespace SearchPipeline { get; }
Property Value
Type | Description |
---|---|
Low |
Security
Security APIs
Declaration
public LowLevelSecurityNamespace Security { get; }
Property Value
Type | Description |
---|---|
Low |
Serializer
Declaration
public IOpenSearchSerializer Serializer { get; }
Property Value
Type | Description |
---|---|
IOpen |
Settings
Declaration
public IConnectionConfigurationValues Settings { get; }
Property Value
Type | Description |
---|---|
IConnection |
Sm
Sm APIs
Declaration
public LowLevelSmNamespace Sm { get; }
Property Value
Type | Description |
---|---|
Low |
Snapshot
Snapshot APIs
Declaration
public LowLevelSnapshotNamespace Snapshot { get; }
Property Value
Type | Description |
---|---|
Low |
Sql
Sql APIs
Declaration
public LowLevelSqlNamespace Sql { get; }
Property Value
Type | Description |
---|---|
Low |
Tasks
Tasks APIs
Declaration
public LowLevelTasksNamespace Tasks { get; }
Property Value
Type | Description |
---|---|
Low |
Transforms
Transforms APIs
Declaration
public LowLevelTransformsNamespace Transforms { get; }
Property Value
Type | Description |
---|---|
Low |
Transport
Declaration
protected ITransport<IConnectionConfigurationValues> Transport { get; set; }
Property Value
Type | Description |
---|---|
ITransport<IConnection |
Wlm
Wlm APIs
Declaration
public LowLevelWlmNamespace Wlm { get; }
Property Value
Type | Description |
---|---|
Low |
Methods
| Edit this page View SourceBulkAsync<TResponse>(PostData, BulkRequestParameters, CancellationToken)
POST on /_bulk
https://opensearch.org/docs/latest/api-reference/document-apis/bulk/
Declaration
public Task<TResponse> BulkAsync<TResponse>(PostData body, BulkRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Bulk |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | |
Bulk |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public Task<TResponse> BulkStreamAsync<TResponse>(PostData body, BulkStreamRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Bulk |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | |
Bulk |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse BulkStream<TResponse>(PostData body, BulkStreamRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Bulk |
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
public 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. |
Post |
body | |
Bulk |
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
public TResponse Bulk<TResponse>(PostData body, BulkRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Bulk |
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
public 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. |
Post |
body | |
Bulk |
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
public Task<TResponse> ClearScrollAsync<TResponse>(PostData body, ClearScrollRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | Comma-separated list of scroll IDs to clear if none was specified using the |
Clear |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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.")]
public 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 |
Post |
body | Comma-separated list of scroll IDs to clear if none was specified using the |
Clear |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse ClearScroll<TResponse>(PostData body, ClearScrollRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | Comma-separated list of scroll IDs to clear if none was specified using the |
Clear |
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.")]
public 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 |
Post |
body | Comma-separated list of scroll IDs to clear if none was specified using the |
Clear |
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
public Task<TResponse> CountAsync<TResponse>(PostData body, CountRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | Query to restrict the results specified with the Query DSL (optional). |
Count |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 ( |
Post |
body | Query to restrict the results specified with the Query DSL (optional). |
Count |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse Count<TResponse>(PostData body, CountRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | Query to restrict the results specified with the Query DSL (optional). |
Count |
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
public 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 ( |
Post |
body | Query to restrict the results specified with the Query DSL (optional). |
Count |
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
public 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 ( |
string | id | Unique identifier for the document. |
Post |
body | The document. |
Create |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 |
Create |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 |
Create |
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
public 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 ( |
string | id | Unique identifier for the document. |
Post |
body | The document. |
Create |
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
public Task<TResponse> DeleteAllPitsAsync<TResponse>(DeleteAllPitsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Delete |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse DeleteAllPits<TResponse>(DeleteAllPitsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Delete |
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
public 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. |
Delete |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 ( |
Post |
body | The search definition using the Query DSL. |
Delete |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Delete |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse DeleteByQueryRethrottle<TResponse>(string taskId, DeleteByQueryRethrottleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
string | taskId | The ID for the task. |
Delete |
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
public 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 ( |
Post |
body | The search definition using the Query DSL. |
Delete |
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
public Task<TResponse> DeletePitAsync<TResponse>(PostData body, DeletePitRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The point-in-time ids to be deleted. |
Delete |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse DeletePit<TResponse>(PostData body, DeletePitRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The point-in-time ids to be deleted. |
Delete |
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
public 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. |
Delete |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Delete |
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
public 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. |
Delete |
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
public 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 |
---|---|---|
Http |
method | the HTTP Method to use |
string | path | The path of the the url that you would like to hit |
Cancellation |
cancellationToken | |
Post |
data | The body of the request, string and byte[] are posted as is other types will be serialized to JSON |
IRequest |
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
public TResponse DoRequest<TResponse>(HttpMethod method, string path, PostData data = null, IRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Http |
method | the HTTP Method to use |
string | path | The path of the the url that you would like to hit |
Post |
data | The body of the request, string and byte[] are posted as is other types will be serialized to JSON |
IRequest |
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
public 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. |
Document |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Document |
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
public Task<TResponse> ExecutePainlessScriptAsync<TResponse>(PostData body, ExecutePainlessScriptRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The script to execute. |
Execute |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse ExecutePainlessScript<TResponse>(PostData body, ExecutePainlessScriptRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The script to execute. |
Execute |
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
public 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. |
Post |
body | The query definition using the Query DSL. |
Explain |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | The query definition using the Query DSL. |
Explain |
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
public Task<TResponse> FieldCapabilitiesAsync<TResponse>(FieldCapabilitiesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Field |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public Task<TResponse> FieldCapabilitiesAsync<TResponse>(PostData body, FieldCapabilitiesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | An index filter specified with the Query DSL. |
Field |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
FieldCapabilitiesAsync<TResponse>(string, FieldCapabilitiesRequestParameters, CancellationToken)
POST on /{index}/_field_caps
Declaration
public 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 |
Field |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 |
Post |
body | An index filter specified with the Query DSL. |
Field |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
FieldCapabilities<TResponse>(FieldCapabilitiesRequestParameters)
POST on /_field_caps
Declaration
public TResponse FieldCapabilities<TResponse>(FieldCapabilitiesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Field |
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
public TResponse FieldCapabilities<TResponse>(PostData body, FieldCapabilitiesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | An index filter specified with the Query DSL. |
Field |
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
public 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 |
Field |
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
public 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 |
Post |
body | An index filter specified with the Query DSL. |
Field |
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
public Task<TResponse> GetAllPitsAsync<TResponse>(GetAllPitsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Get |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse GetAllPits<TResponse>(GetAllPitsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Get |
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
public 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. |
Get |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Get |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public Task<TResponse> GetScriptContextAsync<TResponse>(GetScriptContextRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Get |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse GetScriptContext<TResponse>(GetScriptContextRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Get |
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
public Task<TResponse> GetScriptLanguagesAsync<TResponse>(GetScriptLanguagesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Get |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse GetScriptLanguages<TResponse>(GetScriptLanguagesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Get |
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
public 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. |
Get |
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
public 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. |
Get |
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
public 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. |
Post |
body | The document. |
Index |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | The document. |
Index |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | The document. |
Index |
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
public 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. |
Post |
body | The document. |
Index |
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
public Task<TResponse> MultiGetAsync<TResponse>(PostData body, MultiGetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | Document identifiers; can be either |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 |
Post |
body | Document identifiers; can be either |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse MultiGet<TResponse>(PostData body, MultiGetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | Document identifiers; can be either |
Multi |
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
public 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 |
Post |
body | Document identifiers; can be either |
Multi |
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
public Task<TResponse> MultiSearchAsync<TResponse>(PostData body, MultiSearchRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public Task<TResponse> MultiSearchTemplateAsync<TResponse>(PostData body, MultiSearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 ( |
Post |
body | |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse MultiSearchTemplate<TResponse>(PostData body, MultiSearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Multi |
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
public 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 ( |
Post |
body | |
Multi |
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
public TResponse MultiSearch<TResponse>(PostData body, MultiSearchRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Multi |
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
public 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. |
Post |
body | |
Multi |
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
public Task<TResponse> MultiTermVectorsAsync<TResponse>(PostData body, MultiTermVectorsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
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. |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
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. |
Multi |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
MultiTermVectors<TResponse>(PostData, MultiTermVectorsRequestParameters)
POST on /_mtermvectors
https://opensearch.org/docs/latest
Declaration
public TResponse MultiTermVectors<TResponse>(PostData body, MultiTermVectorsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
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. |
Multi |
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
public 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. |
Post |
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. |
Multi |
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
public Task<TResponse> PingAsync<TResponse>(PingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Ping |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
Ping<TResponse>(PingRequestParameters)
HEAD on /
https://opensearch.org/docs/latest
Declaration
public TResponse Ping<TResponse>(PingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Ping |
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
public 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. |
Post |
body | The document. |
Put |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | The document. |
Put |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | The document. |
Put |
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
public 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. |
Post |
body | The document. |
Put |
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
public Task<TResponse> RankEvalAsync<TResponse>(PostData body, RankEvalRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. |
Rank |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 ( |
Post |
body | The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. |
Rank |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse RankEval<TResponse>(PostData body, RankEvalRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. |
Rank |
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
public 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 ( |
Post |
body | The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. |
Rank |
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
public Task<TResponse> ReindexOnServerAsync<TResponse>(PostData body, ReindexOnServerRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition using the Query DSL and the prototype for the index request. |
Reindex |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse ReindexOnServer<TResponse>(PostData body, ReindexOnServerRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition using the Query DSL and the prototype for the index request. |
Reindex |
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
public 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. |
Reindex |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse ReindexRethrottle<TResponse>(string taskId, ReindexRethrottleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
string | taskId | Identifier for the task. |
Reindex |
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
public Task<TResponse> RenderSearchTemplateAsync<TResponse>(PostData body, RenderSearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition template and its parameters. |
Render |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 |
Post |
body | The search definition template and its parameters. |
Render |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse RenderSearchTemplate<TResponse>(PostData body, RenderSearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition template and its parameters. |
Render |
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
public 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 |
Post |
body | The search definition template and its parameters. |
Render |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Returns
Type | Description |
---|---|
TResponse |
Type Parameters
Name | Description |
---|---|
TResponse |
RequestParams<TRequestParams>(TRequestParams, string, string)
Declaration
protected TRequestParams RequestParams<TRequestParams>(TRequestParams requestParams, string contentType = null, string accept = null) where TRequestParams : class, IRequestParameters, new()
Parameters
Returns
Type | Description |
---|---|
TRequest |
Type Parameters
Name | Description |
---|---|
TRequestParams |
RootNodeInfoAsync<TResponse>(RootNodeInfoRequestParameters, CancellationToken)
GET on /
https://opensearch.org/docs/latest
Declaration
public Task<TResponse> RootNodeInfoAsync<TResponse>(RootNodeInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Root |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
RootNodeInfo<TResponse>(RootNodeInfoRequestParameters)
GET on /
https://opensearch.org/docs/latest
Declaration
public TResponse RootNodeInfo<TResponse>(RootNodeInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Root |
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
public Task<TResponse> ScrollAsync<TResponse>(PostData body, ScrollRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Scroll |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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.")]
public 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. |
Post |
body | |
Scroll |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse Scroll<TResponse>(PostData body, ScrollRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | |
Scroll |
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.")]
public TResponse Scroll<TResponse>(string scrollId, PostData body, ScrollRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
string | scrollId | The scroll ID. |
Post |
body | |
Scroll |
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
public Task<TResponse> SearchAsync<TResponse>(PostData body, SearchRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition using the Query DSL. |
Search |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 ( |
Post |
body | The search definition using the Query DSL. |
Search |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public Task<TResponse> SearchShardsAsync<TResponse>(SearchShardsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Search |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Search |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
SearchShards<TResponse>(SearchShardsRequestParameters)
POST on /_search_shards
https://opensearch.org/docs/latest
Declaration
public TResponse SearchShards<TResponse>(SearchShardsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Search |
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
public 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. |
Search |
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
public Task<TResponse> SearchTemplateAsync<TResponse>(PostData body, SearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition template and its parameters. |
Search |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 (*). |
Post |
body | The search definition template and its parameters. |
Search |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse SearchTemplate<TResponse>(PostData body, SearchTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition template and its parameters. |
Search |
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
public 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 (*). |
Post |
body | The search definition template and its parameters. |
Search |
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
public TResponse Search<TResponse>(PostData body, SearchRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
Post |
body | The search definition using the Query DSL. |
Search |
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
public 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 ( |
Post |
body | The search definition using the Query DSL. |
Search |
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
public 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. |
Source |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Source |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Source |
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
public 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. |
Source |
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
public 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. |
Post |
body | Define parameters and or supply a document to get termvectors for. See documentation. |
Term |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | Define parameters and or supply a document to get termvectors for. See documentation. |
Term |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Post |
body | Define parameters and or supply a document to get termvectors for. See documentation. |
Term |
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
public 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. |
Post |
body | Define parameters and or supply a document to get termvectors for. See documentation. |
Term |
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
public 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. |
Post |
body | The request definition requires either |
Update |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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 ( |
Post |
body | The search definition using the Query DSL. |
Update |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public 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. |
Update |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
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
public TResponse UpdateByQueryRethrottle<TResponse>(string taskId, UpdateByQueryRethrottleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type | Name | Description |
---|---|---|
string | taskId | The ID for the task. |
Update |
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
public 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 ( |
Post |
body | The search definition using the Query DSL. |
Update |
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
public 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. |
Post |
body | The request definition requires either |
Update |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Returns
Type | Description |
---|---|
TResponse |
Type Parameters
Name | Description |
---|---|
TResponse |
Url(FormattableString)
Declaration
protected string Url(FormattableString formattable)
Parameters
Type | Name | Description |
---|---|---|
Formattable |
formattable |
Returns
Type | Description |
---|---|
string |