Search Results for

    Show / Hide Table of Contents

    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

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

    BulkStreamRequestParameters

    Request options for BulkStream

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

    BytesResponse

    CertificateValidations

    A collection of handy baked in server certificate validation callbacks

    ClearScrollRequestParameters

    Request options for ClearScroll

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

    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

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

    CreatePitRequestParameters

    Request options for CreatePit

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

    CreateRequestParameters

    Request options for Create

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

    CustomResponseBuilderBase

    DateTimeProvider

    DeleteAllPitsRequestParameters

    Request options for DeleteAllPits

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

    DeleteByQueryRequestParameters

    Request options for DeleteByQuery

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

    DeleteByQueryRethrottleRequestParameters

    Request options for DeleteByQueryRethrottle

    https://opensearch.org/docs/latest

    DeletePitRequestParameters

    Request options for DeletePit

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

    DeleteRequestParameters

    Request options for Delete

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

    DeleteScriptRequestParameters

    Request options for DeleteScript

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

    DocumentExistsRequestParameters

    Request options for DocumentExists

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

    DynamicDictionary

    A dictionary that supports dynamic access.

    DynamicResponse

    DynamicValue

    Error

    ErrorCause

    ExecutePainlessScriptRequestParameters

    Request options for ExecutePainlessScript

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

    ExplainRequestParameters

    Request options for Explain

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

    FieldCapabilitiesRequestParameters

    Request options for FieldCapabilities

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

    GetAllPitsRequestParameters

    Request options for GetAllPits

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

    GetRequestParameters

    Request options for Get

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

    GetScriptContextRequestParameters

    Request options for GetScriptContext

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

    GetScriptLanguagesRequestParameters

    Request options for GetScriptLanguages

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

    GetScriptRequestParameters

    Request options for GetScript

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

    HttpConnection

    The default IConnection implementation. Uses HttpClient.

    HttpWebRequestConnection

    InMemoryConnection

    IndexRequestParameters

    Request options for Index

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

    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

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

    MultiSearchRequestParameters

    Request options for MultiSearch

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

    MultiSearchTemplateRequestParameters

    Request options for MultiSearchTemplate

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

    MultiTermVectorsRequestParameters

    Request options for MultiTermVectors

    https://opensearch.org/docs/latest

    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

    https://opensearch.org/docs/latest

    PipelineException

    PostData

    PostData<T>

    PutScriptRequestParameters

    Request options for PutScript

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

    RankEvalRequestParameters

    Request options for RankEval

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

    RecyclableMemoryStreamFactory

    A factory for creating memory streams using a recyclable pool of MemoryStream instances

    ReindexOnServerRequestParameters

    Request options for ReindexOnServer

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

    ReindexRethrottleRequestParameters

    Request options for ReindexRethrottle

    https://opensearch.org/docs/latest

    RenderSearchTemplateRequestParameters

    Request options for RenderSearchTemplate

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

    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

    https://opensearch.org/docs/latest

    ScrollRequestParameters

    Request options for Scroll

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

    SearchRequestParameters

    Request options for Search

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

    SearchShardsRequestParameters

    Request options for SearchShards

    https://opensearch.org/docs/latest

    SearchTemplateRequestParameters

    Request options for SearchTemplate

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

    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

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

    SourceRequestParameters

    Request options for Source

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

    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

    TermVectorsRequestParameters

    Request options for TermVectors

    https://opensearch.org/docs/latest

    Transport<TConnectionSettings>

    UnexpectedOpenSearchClientException

    UpdateByQueryRequestParameters

    Request options for UpdateByQuery

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

    UpdateByQueryRethrottleRequestParameters

    Request options for UpdateByQueryRethrottle

    https://opensearch.org/docs/latest

    UpdateRequestParameters

    Request options for Update

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

    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

    ClusterHealthLevel

    ClusterRerouteMetric

    ClusterStateMetric

    ClusterStatsIndexMetric

    ClusterStatsMetric

    Conflicts

    DefaultOperator

    ExpandWildcards

    HealthStatus

    HttpMethod

    IndexApiBlock

    IndicesShardStoresShardStoreStatus

    IndicesStatsMetric

    Level

    NodesInfoMetric

    NodesSampleType

    NodesStatsIndexMetric

    NodesStatsMetric

    NodesUsageMetric

    NotificationsNotificationConfigType

    OpType

    PipelineFailure

    PostType

    Refresh

    SearchType

    SerializationFormatting

    A hint to IOpenSearchSerializer how to format the json. Implementation of IOpenSearchSerializer might choose to ignore this hint though.

    SlicesCalculation

    SuggestMode

    TasksGroupBy

    TimeUnit

    VersionType

    WaitForActiveShardOptions

    WaitForEvents

    In this article
    • Classes
    • Interfaces
    • Enums
    Back to top Generated by DocFX