Search Results for

    Show / Hide Table of Contents

    Class PlainRequestBase<TParameters>

    Inheritance
    object
    RequestBase<TParameters>
    PlainRequestBase<TParameters>
    AddAgenticMemoryRequest
    AddIndexBlockRequest
    AliasExistsRequest
    AnalyzeRequest
    ArbitraryHttpRequestBase<TParams>
    BulkAliasRequest
    BulkRequest
    BulkStreamRequest
    CancelTasksRequest
    CatAliasesRequest
    CatAllPitSegmentsRequest
    CatAllocationRequest
    CatClusterManagerRequest
    CatCountRequest
    CatFielddataRequest
    CatHealthRequest
    CatHelpRequest
    CatIndicesRequest
    CatMasterRequest
    CatNodeAttributesRequest
    CatNodesRequest
    CatPendingTasksRequest
    CatPitSegmentsRequest
    CatPluginsRequest
    CatRecoveryRequest
    CatRepositoriesRequest
    CatSegmentReplicationRequest
    CatSegmentsRequest
    CatShardsRequest
    CatSnapshotsRequest
    CatTasksRequest
    CatTemplatesRequest
    CatThreadPoolRequest
    ChunkModelRequest
    CleanupRepositoryRequest
    ClearCacheRequest
    ClearScrollRequest
    CloneIndexRequest
    CloneSnapshotRequest
    CloseIndexRequest
    ClusterAllocationExplainRequest
    ClusterGetSettingsRequest
    ClusterHealthRequest
    ClusterPendingTasksRequest
    ClusterPutSettingsRequest
    ClusterRerouteRequest
    ClusterStateRequest
    ClusterStatsRequest
    ComponentTemplateExistsRequest
    ComposableIndexTemplateExistsRequest
    CountRequest
    CreateConnectorRequest
    CreateControllerRequest
    CreateIndexRequest
    CreateMemoryContainerRequest
    CreateMemoryContainerSessionRequest
    CreateMemoryRequest
    CreateMessageRequest
    CreateModelMetaRequest
    CreatePitRequest
    CreateRepositoryRequest
    CreateRequest<TDocument>
    DeleteAgentRequest
    DeleteAgenticMemoryQueryRequest
    DeleteAgenticMemoryRequest
    DeleteAliasRequest
    DeleteAllPitsRequest
    DeleteByQueryRequest
    DeleteByQueryRethrottleRequest
    DeleteComponentTemplateRequest
    DeleteComposableIndexTemplateRequest
    DeleteConnectorRequest
    DeleteControllerRequest
    DeleteDanglingIndexRequest
    DeleteExperimentsRequest
    DeleteIndexRequest
    DeleteIndexTemplateRequest
    DeleteJudgmentsRequest
    DeleteMemoryContainerRequest
    DeleteMemoryRequest
    DeleteModelGroupRequest
    DeleteModelRequest
    DeletePipelineRequest
    DeletePitRequest
    DeleteQuerySetsRequest
    DeleteRepositoryRequest
    DeleteRequest
    DeleteScheduledExperimentsRequest
    DeleteScriptRequest
    DeleteSearchConfigurationsRequest
    DeleteSearchPipelineRequest
    DeleteSnapshotRequest
    DeleteTaskRequest
    DeleteVotingConfigExclusionsRequest
    DeployModelRequest
    DocumentExistsRequest
    ExecuteAgentRequest
    ExecuteAlgorithmRequest
    ExecutePainlessScriptRequest
    ExecuteToolRequest
    ExperimentsSearchRequest
    ExplainRequest
    FieldCapabilitiesRequest
    FlushRequest
    ForceMergeRequest
    GetAgentRequest
    GetAgenticMemoryRequest
    GetAliasRequest
    GetAllMemoriesRequest
    GetAllMessagesRequest
    GetAllPitsRequest
    GetAllToolsRequest
    GetComponentTemplateRequest
    GetComposableIndexTemplateRequest
    GetConnectorRequest
    GetControllerRequest
    GetExperimentsRequest
    GetFieldMappingRequest
    GetIndexRequest
    GetIndexSettingsRequest
    GetIndexTemplateRequest
    GetJudgmentsRequest
    GetMLTaskRequest
    GetMappingRequest
    GetMemoryContainerRequest
    GetMemoryRequest
    GetMessageRequest
    GetMessageTracesRequest
    GetModelGroupRequest
    GetModelRequest
    GetNodeStatsRequest
    GetPipelineRequest
    GetProfileModelsRequest
    GetProfileRequest
    GetProfileTasksRequest
    GetQuerySetsRequest
    GetRepositoryRequest
    GetRequest
    GetScheduledExperimentsRequest
    GetScriptRequest
    GetSearchConfigurationsRequest
    GetSearchPipelineRequest
    GetSearchRelevanceStatsRequest
    GetSnapshotRequest
    GetStatsRequest
    GetTaskRequest
    GetToolRequest
    GrokProcessorPatternsRequest
    ImportDanglingIndexRequest
    IndexExistsRequest
    IndexRequest<TDocument>
    IndexTemplateExistsRequest
    IndicesStatsRequest
    JudgmentsSearchRequest
    ListDanglingIndicesRequest
    ListTasksRequest
    LoadModelRequest
    MultiGetRequest
    MultiSearchRequest
    MultiSearchTemplateRequest
    MultiTermVectorsRequest
    NodesHotThreadsRequest
    NodesInfoRequest
    NodesStatsRequest
    NodesUsageRequest
    OpenIndexRequest
    PingRequest
    PostQuerySetsRequest
    PostScheduledExperimentsRequest
    PostVotingConfigExclusionsRequest
    PredictModelRequest
    PredictRequest
    PutAliasRequest
    PutComponentTemplateRequest
    PutComposableIndexTemplateRequest
    PutExperimentsRequest
    PutIndexTemplateRequest
    PutJudgmentsRequest
    PutMappingRequest
    PutPipelineRequest
    PutQuerySetsRequest
    PutScriptRequest
    PutSearchConfigurationsRequest
    PutSearchPipelineRequest
    QuerySetsSearchRequest
    RefreshRequest
    RegisterAgentsRequest
    RegisterModelGroupRequest
    RegisterModelMetaRequest
    RegisterModelRequest
    ReindexOnServerRequest
    ReindexRethrottleRequest
    ReloadSecureSettingsRequest
    RemoteInfoRequest
    RenderSearchTemplateRequest
    ResolveIndexRequest
    RestoreRequest
    RolloverIndexRequest
    RootNodeInfoRequest
    ScrollRequest
    SearchAgenticMemoryRequest
    SearchAgentsRequest
    SearchConfigurationsSearchRequest
    SearchConnectorsRequest
    SearchMemoryContainerRequest
    SearchMemoryRequest
    SearchMessageRequest
    SearchModelGroupRequest
    SearchModelsRequest
    SearchRequest
    SearchShardsRequest
    SearchTasksRequest
    SearchTemplateRequest
    ShrinkIndexRequest
    SimulatePipelineRequest
    SnapshotRequest
    SnapshotStatusRequest
    SourceExistsRequest
    SourceRequest
    SplitIndexRequest
    TermVectorsRequest<TDocument>
    TrainPredictRequest
    TrainRequest
    TypeExistsRequest
    UndeployModelRequest
    UnloadModelRequest
    UpdateAgenticMemoryRequest
    UpdateByQueryRequest
    UpdateByQueryRethrottleRequest
    UpdateConnectorRequest
    UpdateControllerRequest
    UpdateIndexSettingsRequest
    UpdateMemoryContainerRequest
    UpdateMemoryRequest
    UpdateMessageRequest
    UpdateModelGroupRequest
    UpdateModelRequest
    UpdateRequest<TDocument, TPartialDocument>
    UploadChunkRequest
    UploadModelRequest
    ValidateQueryRequest
    VerifyRepositoryRequest
    Implements
    IRequest<TParameters>
    IRequest
    Inherited Members
    RequestBase<TParameters>.HttpMethod
    RequestBase<TParameters>.RequestState
    RequestBase<TParameters>.ContentType
    RequestBase<TParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<TParameters>.RequestDefaults(TParameters)
    RequestBase<TParameters>.Q<TOut>(string)
    RequestBase<TParameters>.Q(string, object)
    RequestBase<TParameters>.SetAcceptHeader(string)
    RequestBase<TParameters>.SetAcceptHeader(Enum)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public abstract class PlainRequestBase<TParameters> : RequestBase<TParameters>, IRequest<TParameters>, IRequest where TParameters : class, IRequestParameters, new()
    Type Parameters
    Name Description
    TParameters

    Constructors

    | Edit this page View Source

    PlainRequestBase()

    Declaration
    protected PlainRequestBase()
    | Edit this page View Source

    PlainRequestBase(Func<RouteValues, RouteValues>)

    Declaration
    protected PlainRequestBase(Func<RouteValues, RouteValues> pathSelector)
    Parameters
    Type Name Description
    Func<RouteValues, RouteValues> pathSelector

    Properties

    | Edit this page View Source

    ErrorTrace

    Include the stack trace of returned errors.

    Declaration
    public bool? ErrorTrace { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    FilterPath

    A comma-separated list of filters used to reduce the response.

    Use of response filtering can result in a response from OpenSearch that cannot be correctly deserialized to the respective response type for the request. In such situations, use the low level client to issue the request and handle response deserialization

    Declaration
    public string[] FilterPath { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    Human

    Return human readable values for statistics.

    Declaration
    public bool? Human { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Pretty

    Pretty format the returned JSON response.

    Declaration
    public bool? Pretty { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    RequestConfiguration

    Specify settings for this request alone, handy if you need a custom timeout or want to bypass sniffing, retries

    Declaration
    public IRequestConfiguration RequestConfiguration { get; set; }
    Property Value
    Type Description
    IRequestConfiguration
    | Edit this page View Source

    SourceQueryString

    The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

    Declaration
    public string SourceQueryString { get; set; }
    Property Value
    Type Description
    string

    Implements

    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX