Search Results for

    Show / Hide Table of Contents

    Class 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.

    Inheritance
    object
    RequestParameters<T>
    BulkRequestParameters
    BulkStreamRequestParameters
    ClearScrollRequestParameters
    CountRequestParameters
    CreatePitRequestParameters
    CreateRequestParameters
    DeleteAllPitsRequestParameters
    DeleteByQueryRequestParameters
    DeleteByQueryRethrottleRequestParameters
    DeletePitRequestParameters
    DeleteRequestParameters
    DeleteScriptRequestParameters
    DocumentExistsRequestParameters
    ExecutePainlessScriptRequestParameters
    ExplainRequestParameters
    FieldCapabilitiesRequestParameters
    GetAllPitsRequestParameters
    GetRequestParameters
    GetScriptContextRequestParameters
    GetScriptLanguagesRequestParameters
    GetScriptRequestParameters
    IndexRequestParameters
    MultiGetRequestParameters
    MultiSearchRequestParameters
    MultiSearchTemplateRequestParameters
    MultiTermVectorsRequestParameters
    PingRequestParameters
    PutScriptRequestParameters
    RankEvalRequestParameters
    ReindexOnServerRequestParameters
    ReindexRethrottleRequestParameters
    RenderSearchTemplateRequestParameters
    RootNodeInfoRequestParameters
    ScrollRequestParameters
    SearchRequestParameters
    SearchShardsRequestParameters
    SearchTemplateRequestParameters
    SourceExistsRequestParameters
    SourceRequestParameters
    DeleteRequestParameters
    GetRequestParameters
    SearchRequestParameters
    StatsRequestParameters
    CatAliasesRequestParameters
    CatAllPitSegmentsRequestParameters
    CatAllocationRequestParameters
    CatClusterManagerRequestParameters
    CatCountRequestParameters
    CatFielddataRequestParameters
    CatHealthRequestParameters
    CatHelpRequestParameters
    CatIndicesRequestParameters
    CatMasterRequestParameters
    CatNodeAttributesRequestParameters
    CatNodesRequestParameters
    CatPendingTasksRequestParameters
    CatPitSegmentsRequestParameters
    CatPluginsRequestParameters
    CatRecoveryRequestParameters
    CatRepositoriesRequestParameters
    CatSegmentReplicationRequestParameters
    CatSegmentsRequestParameters
    CatShardsRequestParameters
    CatSnapshotsRequestParameters
    CatTasksRequestParameters
    CatTemplatesRequestParameters
    CatThreadPoolRequestParameters
    ClusterAllocationExplainRequestParameters
    ClusterGetSettingsRequestParameters
    ClusterHealthRequestParameters
    ClusterPendingTasksRequestParameters
    ClusterPutSettingsRequestParameters
    ClusterRerouteRequestParameters
    ClusterStateRequestParameters
    ClusterStatsRequestParameters
    ComponentTemplateExistsRequestParameters
    DeleteComponentTemplateRequestParameters
    DeleteDecommissionAwarenessRequestParameters
    DeleteVotingConfigExclusionsRequestParameters
    DeleteWeightedRoutingRequestParameters
    GetComponentTemplateRequestParameters
    GetDecommissionAwarenessRequestParameters
    GetWeightedRoutingRequestParameters
    PostVotingConfigExclusionsRequestParameters
    PutComponentTemplateRequestParameters
    PutDecommissionAwarenessRequestParameters
    PutWeightedRoutingRequestParameters
    RemoteInfoRequestParameters
    DeleteDanglingIndexRequestParameters
    ImportDanglingIndexRequestParameters
    ListDanglingIndicesRequestParameters
    CreateRequestParameters
    DeleteRequestParameters
    DeprovisionRequestParameters
    GetRequestParameters
    GetStatusRequestParameters
    GetStepsRequestParameters
    ProvisionRequestParameters
    SearchRequestParameters
    SearchStateRequestParameters
    UpdateRequestParameters
    ArbitraryHttpRequestParameters<TSelf>
    AddIndexBlockRequestParameters
    AliasExistsRequestParameters
    AnalyzeRequestParameters
    BulkAliasRequestParameters
    ClearCacheRequestParameters
    CloneIndexRequestParameters
    CloseIndexRequestParameters
    ComposableIndexTemplateExistsRequestParameters
    CreateDataStreamRequestParameters
    CreateIndexRequestParameters
    DataStreamsStatsRequestParameters
    DeleteAliasRequestParameters
    DeleteComposableIndexTemplateRequestParameters
    DeleteDataStreamRequestParameters
    DeleteIndexRequestParameters
    DeleteIndexTemplateRequestParameters
    FlushRequestParameters
    ForceMergeRequestParameters
    GetAliasRequestParameters
    GetComposableIndexTemplateRequestParameters
    GetDataStreamRequestParameters
    GetFieldMappingRequestParameters
    GetIndexRequestParameters
    GetIndexSettingsRequestParameters
    GetIndexTemplateRequestParameters
    GetMappingRequestParameters
    GetUpgradeRequestParameters
    IndexExistsRequestParameters
    IndexTemplateExistsRequestParameters
    IndicesShardStoresRequestParameters
    IndicesStatsRequestParameters
    OpenIndexRequestParameters
    PutAliasRequestParameters
    PutComposableIndexTemplateRequestParameters
    PutIndexTemplateRequestParameters
    PutMappingRequestParameters
    RecoveryStatusRequestParameters
    RefreshRequestParameters
    ResolveIndexRequestParameters
    RolloverIndexRequestParameters
    SegmentsRequestParameters
    ShrinkIndexRequestParameters
    SimulateIndexTemplateRequestParameters
    SimulateTemplateRequestParameters
    SplitIndexRequestParameters
    SyncedFlushRequestParameters
    TypeExistsRequestParameters
    UpdateIndexSettingsRequestParameters
    UpgradeRequestParameters
    ValidateQueryRequestParameters
    DeletePipelineRequestParameters
    GetPipelineRequestParameters
    GrokProcessorPatternsRequestParameters
    PutPipelineRequestParameters
    SimulatePipelineRequestParameters
    TopQueriesRequestParameters
    AddPolicyRequestParameters
    ChangePolicyRequestParameters
    DeletePolicyRequestParameters
    ExistsPolicyRequestParameters
    ExplainPolicyRequestParameters
    GetPoliciesRequestParameters
    GetPolicyRequestParameters
    PutPoliciesRequestParameters
    PutPolicyRequestParameters
    RefreshSearchAnalyzersRequestParameters
    RemovePolicyRequestParameters
    RetryIndexRequestParameters
    DeleteModelRequestParameters
    GetModelRequestParameters
    SearchModelsRequestParameters
    StatsRequestParameters
    TrainModelRequestParameters
    WarmupRequestParameters
    HelpRequestParameters
    IndicesRequestParameters
    ShardsRequestParameters
    StatsRequestParameters
    ChunkModelRequestParameters
    CreateConnectorRequestParameters
    CreateControllerRequestParameters
    CreateMemoryRequestParameters
    CreateMessageRequestParameters
    CreateModelMetaRequestParameters
    DeleteAgentRequestParameters
    DeleteConnectorRequestParameters
    DeleteControllerRequestParameters
    DeleteMemoryRequestParameters
    DeleteModelGroupRequestParameters
    DeleteModelRequestParameters
    DeleteTaskRequestParameters
    DeployModelRequestParameters
    ExecuteAgentRequestParameters
    ExecuteAlgorithmRequestParameters
    GetAgentRequestParameters
    GetAllMemoriesRequestParameters
    GetAllMessagesRequestParameters
    GetAllToolsRequestParameters
    GetConnectorRequestParameters
    GetControllerRequestParameters
    GetMemoryRequestParameters
    GetMessageRequestParameters
    GetMessageTracesRequestParameters
    GetModelGroupRequestParameters
    GetModelRequestParameters
    GetProfileModelsRequestParameters
    GetProfileRequestParameters
    GetProfileTasksRequestParameters
    GetStatsRequestParameters
    GetTaskRequestParameters
    GetToolRequestParameters
    LoadModelRequestParameters
    PredictModelRequestParameters
    PredictRequestParameters
    RegisterAgentsRequestParameters
    RegisterModelGroupRequestParameters
    RegisterModelMetaRequestParameters
    RegisterModelRequestParameters
    SearchAgentsRequestParameters
    SearchConnectorsRequestParameters
    SearchMemoryRequestParameters
    SearchMessageRequestParameters
    SearchModelGroupRequestParameters
    SearchModelsRequestParameters
    SearchTasksRequestParameters
    TrainPredictRequestParameters
    TrainRequestParameters
    UndeployModelRequestParameters
    UnloadModelRequestParameters
    UpdateConnectorRequestParameters
    UpdateControllerRequestParameters
    UpdateMemoryRequestParameters
    UpdateMessageRequestParameters
    UpdateModelGroupRequestParameters
    UpdateModelRequestParameters
    UploadChunkRequestParameters
    UploadModelRequestParameters
    NodesHotThreadsRequestParameters
    NodesInfoRequestParameters
    NodesStatsRequestParameters
    NodesUsageRequestParameters
    ReloadSecureSettingsRequestParameters
    CreateConfigRequestParameters
    DeleteConfigRequestParameters
    DeleteConfigsRequestParameters
    GetConfigRequestParameters
    GetConfigsRequestParameters
    ListChannelsRequestParameters
    ListFeaturesRequestParameters
    SendTestRequestParameters
    UpdateConfigRequestParameters
    CreateObjectRequestParameters
    DeleteObjectRequestParameters
    DeleteObjectsRequestParameters
    GetLocalstatsRequestParameters
    GetObjectRequestParameters
    ListObjectsRequestParameters
    UpdateObjectRequestParameters
    ExplainRequestParameters
    GetStatsRequestParameters
    PostStatsRequestParameters
    QueryRequestParameters
    DatasourceDeleteRequestParameters
    DatasourceRetrieveRequestParameters
    DatasourcesCreateRequestParameters
    DatasourcesListRequestParameters
    DatasourcesUpdateRequestParameters
    RestoreRequestParameters
    AutofollowStatsRequestParameters
    CreateReplicationRuleRequestParameters
    DeleteReplicationRuleRequestParameters
    FollowerStatsRequestParameters
    LeaderStatsRequestParameters
    PauseRequestParameters
    ResumeRequestParameters
    StartRequestParameters
    StatusRequestParameters
    StopRequestParameters
    UpdateSettingsRequestParameters
    DeleteRequestParameters
    ExplainRequestParameters
    GetRequestParameters
    PutRequestParameters
    StartRequestParameters
    StopRequestParameters
    DeleteRequestParameters
    GetRequestParameters
    PutRequestParameters
    AuthinfoRequestParameters
    AuthtokenRequestParameters
    CacheRequestParameters
    ChangePasswordRequestParameters
    ConfigUpgradeCheckRequestParameters
    ConfigUpgradePerformRequestParameters
    CreateActionGroupRequestParameters
    CreateAllowlistRequestParameters
    CreateRoleMappingRequestParameters
    CreateRoleRequestParameters
    CreateTenantRequestParameters
    CreateUpdateTenancyConfigRequestParameters
    CreateUserLegacyRequestParameters
    CreateUserRequestParameters
    DeleteActionGroupRequestParameters
    DeleteDistinguishedNameRequestParameters
    DeleteRoleMappingRequestParameters
    DeleteRoleRequestParameters
    DeleteTenantRequestParameters
    DeleteUserLegacyRequestParameters
    DeleteUserRequestParameters
    FlushCacheRequestParameters
    GenerateOboTokenRequestParameters
    GenerateUserTokenLegacyRequestParameters
    GenerateUserTokenRequestParameters
    GetAccountDetailsRequestParameters
    GetActionGroupRequestParameters
    GetActionGroupsRequestParameters
    GetAllCertificatesRequestParameters
    GetAllowlistRequestParameters
    GetAuditConfigurationRequestParameters
    GetCertificatesRequestParameters
    GetConfigurationRequestParameters
    GetDashboardsInfoRequestParameters
    GetDistinguishedNameRequestParameters
    GetDistinguishedNamesRequestParameters
    GetNodeCertificatesRequestParameters
    GetPermissionsInfoRequestParameters
    GetRoleMappingRequestParameters
    GetRoleMappingsRequestParameters
    GetRoleRequestParameters
    GetRolesRequestParameters
    GetSslinfoRequestParameters
    GetTenancyConfigRequestParameters
    GetTenantRequestParameters
    GetTenantsRequestParameters
    GetUserLegacyRequestParameters
    GetUserRequestParameters
    GetUsersLegacyRequestParameters
    GetUsersRequestParameters
    HealthRequestParameters
    MigrateRequestParameters
    PatchActionGroupRequestParameters
    PatchActionGroupsRequestParameters
    PatchAllowlistRequestParameters
    PatchAuditConfigurationRequestParameters
    PatchConfigurationRequestParameters
    PatchDistinguishedNameRequestParameters
    PatchDistinguishedNamesRequestParameters
    PatchRoleMappingRequestParameters
    PatchRoleMappingsRequestParameters
    PatchRoleRequestParameters
    PatchRolesRequestParameters
    PatchTenantRequestParameters
    PatchTenantsRequestParameters
    PatchUserRequestParameters
    PatchUsersRequestParameters
    PostDashboardsInfoRequestParameters
    ReloadHttpCertificatesRequestParameters
    ReloadTransportCertificatesRequestParameters
    TenantInfoRequestParameters
    UpdateAuditConfigurationRequestParameters
    UpdateConfigurationRequestParameters
    UpdateDistinguishedNameRequestParameters
    ValidateRequestParameters
    WhoAmIProtectedRequestParameters
    WhoAmIRequestParameters
    CreatePolicyRequestParameters
    DeletePolicyRequestParameters
    ExplainPolicyRequestParameters
    GetPoliciesRequestParameters
    GetPolicyRequestParameters
    StartPolicyRequestParameters
    StopPolicyRequestParameters
    UpdatePolicyRequestParameters
    CleanupRepositoryRequestParameters
    CloneSnapshotRequestParameters
    CreateRepositoryRequestParameters
    DeleteRepositoryRequestParameters
    DeleteSnapshotRequestParameters
    GetRepositoryRequestParameters
    GetSnapshotRequestParameters
    RestoreRequestParameters
    SnapshotRequestParameters
    SnapshotStatusRequestParameters
    VerifyRepositoryRequestParameters
    CloseRequestParameters
    ExplainRequestParameters
    GetStatsRequestParameters
    PostStatsRequestParameters
    QueryRequestParameters
    SettingsRequestParameters
    CancelTasksRequestParameters
    GetTaskRequestParameters
    ListTasksRequestParameters
    DeleteRequestParameters
    ExplainRequestParameters
    GetRequestParameters
    PreviewRequestParameters
    PutRequestParameters
    SearchRequestParameters
    StartRequestParameters
    StopRequestParameters
    CreateQueryGroupRequestParameters
    DeleteQueryGroupRequestParameters
    GetQueryGroupRequestParameters
    UpdateQueryGroupRequestParameters
    TermVectorsRequestParameters
    UpdateByQueryRequestParameters
    UpdateByQueryRethrottleRequestParameters
    UpdateRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net
    Assembly: OpenSearch.Net.dll
    Syntax
    public abstract class RequestParameters<T> : IRequestParameters where T : RequestParameters<T>
    Type Parameters
    Name Description
    T

    Properties

    | Edit this page View Source

    CustomResponseBuilder

    Allows you to completely circumvent the serializer to build the final response.

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

    DefaultHttpMethod

    Declaration
    public abstract HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    | Edit this page View Source

    QueryString

    The querystring that should be appended to the path of the request

    Declaration
    public Dictionary<string, object> QueryString { get; set; }
    Property Value
    Type Description
    Dictionary<string, object>
    | Edit this page View Source

    RequestConfiguration

    Configuration for this specific request, i.e disable sniffing, custom timeouts etcetera.

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

    SupportsBody

    Declaration
    public abstract bool SupportsBody { get; }
    Property Value
    Type Description
    bool

    Methods

    | Edit this page View Source

    AcceptHeaderFromFormat(string)

    Gets the HTTP Accept Header value from the shortened name. If the shortened name is not recognized, null is returned.

    Declaration
    public string AcceptHeaderFromFormat(string format)
    Parameters
    Type Name Description
    string format
    Returns
    Type Description
    string
    | Edit this page View Source

    ContainsQueryString(string)

    Declaration
    public bool ContainsQueryString(string name)
    Parameters
    Type Name Description
    string name
    Returns
    Type Description
    bool
    | Edit this page View Source

    GetQueryStringValue<TOut>(string)

    Get's the value as its stored on the querystring using its original type

    Declaration
    public TOut GetQueryStringValue<TOut>(string name)
    Parameters
    Type Name Description
    string name
    Returns
    Type Description
    TOut
    Type Parameters
    Name Description
    TOut
    | Edit this page View Source

    GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

    Gets the stringified representation of a query string value as it would be sent to OpenSearch.

    Declaration
    public string GetResolvedQueryStringValue(string n, IConnectionConfigurationValues s)
    Parameters
    Type Name Description
    string n
    IConnectionConfigurationValues s
    Returns
    Type Description
    string
    | Edit this page View Source

    Q(string, object)

    Declaration
    protected void Q(string name, object value)
    Parameters
    Type Name Description
    string name
    object value
    | Edit this page View Source

    Q<TOut>(string)

    Declaration
    protected TOut Q<TOut>(string name)
    Parameters
    Type Name Description
    string name
    Returns
    Type Description
    TOut
    Type Parameters
    Name Description
    TOut
    | Edit this page View Source

    SetAcceptHeader(string)

    Declaration
    protected void SetAcceptHeader(string format)
    Parameters
    Type Name Description
    string format
    | Edit this page View Source

    SetQueryString(string, object)

    Sets a query string param. If value is null and the parameter exists it will be removed

    Declaration
    public void SetQueryString(string name, object value)
    Parameters
    Type Name Description
    string name

    The query string parameter to add

    object value

    The value to set, if null removes name from the query string if it exists

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • CustomResponseBuilder
      • DefaultHttpMethod
      • QueryString
      • RequestConfiguration
      • SupportsBody
    • Methods
      • AcceptHeaderFromFormat(string)
      • ContainsQueryString(string)
      • GetQueryStringValue<TOut>(string)
      • GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
      • Q(string, object)
      • Q<TOut>(string)
      • SetAcceptHeader(string)
      • SetQueryString(string, object)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX