Namespace OpenSearch.Net
Classes
ApiCallDetails
ApiKeyAuthenticationCredentials
Credentials for Api Key Authentication
Audit
An audit of the request made
BasicAuthenticationCredentials
Credentials for Basic Authentication
BulkRequestParameters
Request options for Bulk
<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk/</p>
BulkStreamRequestParameters
Request options for BulkStream
<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk-streaming/</p>
BytesResponse
CertificateValidations
A collection of handy baked in server certificate validation callbacks
ClearScrollRequestParameters
Request options for ClearScroll
<p>https://docs.opensearch.org/latest/api-reference/scroll/</p>
CloudConnectionPool
An IConnectionPool implementation that can be seeded with a cloud id and will signal the right defaults for the client to use for OpenSearch Cloud to IConnectionConfigurationValues.
Read more about OpenSearch Cloud Id:
ConnectionConfiguration
Allows you to control how OpenSearchLowLevelClient behaves and where/how it connects to OpenSearch
ConnectionInfo
CountRequestParameters
Request options for Count
<p>https://docs.opensearch.org/latest/api-reference/count/</p>
CreatePitRequestParameters
Request options for CreatePit
<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#create-a-pit</p>
CreateRequestParameters
Request options for Create
<p>https://docs.opensearch.org/latest/api-reference/document-apis/index-document/</p>
CustomResponseBuilderBase
DateTimeProvider
DeleteAllPitsRequestParameters
Request options for DeleteAllPits
<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#delete-pits</p>
DeleteByQueryRequestParameters
Request options for DeleteByQuery
<p>https://docs.opensearch.org/latest/api-reference/document-apis/delete-by-query/</p>
DeleteByQueryRethrottleRequestParameters
Request options for DeleteByQueryRethrottle
<p>https://docs.opensearch.org/latest/</p>
DeletePitRequestParameters
Request options for DeletePit
<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#delete-pits</p>
DeleteRequestParameters
Request options for Delete
<p>https://docs.opensearch.org/latest/api-reference/document-apis/delete-document/</p>
DeleteScriptRequestParameters
Request options for DeleteScript
<p>https://docs.opensearch.org/latest/api-reference/script-apis/delete-script/</p>
DocumentExistsRequestParameters
Request options for DocumentExists
<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>
DynamicDictionary
A dictionary that supports dynamic access.
DynamicResponse
DynamicValue
Error
ErrorCause
ExecutePainlessScriptRequestParameters
Request options for ExecutePainlessScript
<p>https://docs.opensearch.org/latest/api-reference/script-apis/exec-script/</p>
ExplainRequestParameters
Request options for Explain
<p>https://docs.opensearch.org/latest/api-reference/explain/</p>
FieldCapabilitiesRequestParameters
Request options for FieldCapabilities
<p>https://docs.opensearch.org/latest/mappings/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations</p>
GetAllPitsRequestParameters
Request options for GetAllPits
<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#list-all-pits</p>
GetRequestParameters
Request options for Get
<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>
GetScriptContextRequestParameters
Request options for GetScriptContext
<p>https://docs.opensearch.org/latest/api-reference/script-apis/get-script-contexts/</p>
GetScriptLanguagesRequestParameters
Request options for GetScriptLanguages
<p>https://docs.opensearch.org/latest/api-reference/script-apis/get-script-language/</p>
GetScriptRequestParameters
Request options for GetScript
<p>https://docs.opensearch.org/latest/api-reference/script-apis/get-stored-script/</p>
HttpConnection
The default IConnection implementation. Uses HttpClient.
HttpWebRequestConnection
InMemoryConnection
IndexRequestParameters
Request options for Index
<p>https://docs.opensearch.org/latest/api-reference/document-apis/index-document/</p>
KnownEnums
LowLevelRequestResponseSerializer
MemoryStreamFactory
A factory for creating memory streams using instances of MemoryStream
MetaHeaderProvider
Produces the meta header when this functionality is enabled in the ConnectionConfiguration.
MultiGetRequestParameters
Request options for MultiGet
<p>https://docs.opensearch.org/latest/api-reference/document-apis/multi-get/</p>
MultiSearchRequestParameters
Request options for MultiSearch
<p>https://docs.opensearch.org/latest/api-reference/multi-search/</p>
MultiSearchTemplateRequestParameters
Request options for MultiSearchTemplate
<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>
MultiTermVectorsRequestParameters
Request options for MultiTermVectors
<p>https://docs.opensearch.org/latest/</p>
NamespacedClientProxy
Node
OpenSearchClientException
OpenSearchLowLevelClient
Low level client that exposes all of OpenSearch API endpoints but leaves you in charge of building request and handling the response
OpenSearchResponseBase
A response from OpenSearch including details about the request/response life cycle
OpenSearchResponse<T>
A response from OpenSearch including details about the request/response life cycle. Base class for the built in low level response types, StringResponse, BytesResponse, DynamicResponse and VoidResponse
OpenSearchSerializerExtensions
OpenSearchUrlFormatter
A formatter that can utilize IConnectionConfigurationValues to resolve IUrlParameter's passed as format arguments. It also handles known string representations for e.g bool/Enums/IEnumerable<object>.
PingRequestParameters
Request options for Ping
<p>https://docs.opensearch.org/latest/</p>
PipelineException
PostData
PostData<T>
PutScriptRequestParameters
Request options for PutScript
<p>https://docs.opensearch.org/latest/api-reference/script-apis/create-stored-script/</p>
RankEvalRequestParameters
Request options for RankEval
<p>https://docs.opensearch.org/latest/api-reference/rank-eval/</p>
RecyclableMemoryStreamFactory
A factory for creating memory streams using a recyclable pool of MemoryStream instances
ReindexOnServerRequestParameters
Request options for ReindexOnServer
<p>https://docs.opensearch.org/latest/im-plugin/reindex-data/</p>
ReindexRethrottleRequestParameters
Request options for ReindexRethrottle
<p>https://docs.opensearch.org/latest/</p>
RenderSearchTemplateRequestParameters
Request options for RenderSearchTemplate
<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>
RequestConfiguration
RequestConfigurationDescriptor
RequestData
RequestMetaData
Holds meta data about a client request.
RequestParameters<T>
Used by the raw client to compose querystring parameters in a matter that still exposes some xmldocs You can always pass a simple NameValueCollection if you want.
RequestPipeline
RequestPipelineFactory
ResponseBuilder
ResponseStatics
RootNodeInfoRequestParameters
Request options for RootNodeInfo
<p>https://docs.opensearch.org/latest/</p>
ScrollRequestParameters
Request options for Scroll
<p>https://docs.opensearch.org/latest/api-reference/search-apis/scroll/#endpoints</p>
SearchRequestParameters
Request options for Search
<p>https://docs.opensearch.org/latest/api-reference/search/</p>
SearchShardsRequestParameters
Request options for SearchShards
<p>https://docs.opensearch.org/latest/</p>
SearchTemplateRequestParameters
Request options for SearchTemplate
<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>
SecureStrings
Methods for working with SecureString
SerializableData<T>
SerializerRegistrationInformation
ServerError
ShardFailure
SingleNodeConnectionPool
A connection pool to a single node or endpoint
SniffParser
SniffingConnectionPool
SourceExistsRequestParameters
Request options for SourceExists
<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>
SourceRequestParameters
Request options for Source
<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>
StaticConnectionPool
StickyConnectionPool
StickySniffingConnectionPool
StreamableData<T>
Represents an instance of PostData that can handle StreamHandler. Allows users full control over how they want to write data to the stream to OpenSearch
StringEnumAttribute
StringResponse
SystemTextJsonEnvironment
Shared environment-variable resolution for the System.Text.Json / Utf8Json engine switch (GitHub issue
#388), used by both OpenSearch.Net.ConnectionConfiguration<T> (the low-level engine) and
OpenSearch.Client.ConnectionSettingsBase (the high-level engine). Each layer's own programmatic
UseSystemTextJson() call takes precedence over this; the two layers select their engines
independently even though they read the same variable.
SystemTextJsonSerializer
A serializer implementation using System.Text.Json, replacing the legacy Utf8Json-based LowLevelRequestResponseSerializer.
TermVectorsRequestParameters
Request options for TermVectors
<p>https://docs.opensearch.org/latest/</p>
Transport<TConnectionSettings>
UnexpectedOpenSearchClientException
UpdateByQueryRequestParameters
Request options for UpdateByQuery
<p>https://docs.opensearch.org/latest/api-reference/document-apis/update-by-query/</p>
UpdateByQueryRethrottleRequestParameters
Request options for UpdateByQueryRethrottle
<p>https://docs.opensearch.org/latest/</p>
UpdateRequestParameters
Request options for Update
<p>https://docs.opensearch.org/latest/api-reference/document-apis/update-document/</p>
VoidResponse
VoidResponse.VoidBody
Interfaces
IApiCallDetails
Details about the API call
IConnection
IConnectionConfigurationValues
IConnectionPool
IDateTimeProvider
IMemoryStreamFactory
A factory for creating memory streams
IOpenSearchLowLevelClient
OpenSearch low level client
IOpenSearchResponse
The minimum interface your custom responses should implement when providing a response type to the low level client
IOpenSearchSerializer
IPostData<T>
IRequestConfiguration
IRequestParameters
IRequestPipeline
IRequestPipelineFactory
ITransport<TConnectionSettings>
IUrlParameter
Enums
AuditEvent
ByteUnit
CatResponseFormat
ClusterHealthLevel
ClusterRerouteMetric
ClusterStateMetric
ClusterStatsIndexMetric
ClusterStatsMetric
Conflicts
DefaultOperator
ExpandWildcards
HealthStatus
HttpMethod
IndexApiBlock
IndicesShardStoresShardStoreStatus
IndicesStatsMetric
InsightsMetricType
KnnStatName
Level
ListResponseFormat
LtrStatName
MlFunctionName
MlMemoryType
MlStatName
MlToolName
NeuralStatName
NodesInfoMetric
NodesSampleType
NodesStatsIndexMetric
NodesStatsMetric
NodesUsageMetric
NotificationsNotificationConfigType
OpType
PipelineFailure
PostType
PplResponseFormat
Refresh
SearchType
SecurityAnalyticsAlertsAlertSeverityLevel
SecurityAnalyticsAlertsAlertState
SecurityAnalyticsFindingsDetectionType
SecurityAnalyticsFindingsRuleSeverity
SerializationFormatting
A hint to IOpenSearchSerializer how to format the json. Implementation of IOpenSearchSerializer might choose to ignore this hint though.