Search Results for

    Show / Hide Table of Contents

    Interface IRequestParameters

    Namespace: OpenSearch.Net
    Assembly: OpenSearch.Net.dll
    Syntax
    public interface IRequestParameters

    Properties

    | Edit this page View Source

    CustomResponseBuilder

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

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

    DefaultHttpMethod

    Declaration
    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
    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
    IRequestConfiguration RequestConfiguration { get; set; }
    Property Value
    Type Description
    IRequestConfiguration
    | Edit this page View Source

    SupportsBody

    Declaration
    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
    string AcceptHeaderFromFormat(string format)
    Parameters
    Type Name Description
    string format
    Returns
    Type Description
    string
    | Edit this page View Source

    ContainsQueryString(string)

    Declaration
    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
    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
    string GetResolvedQueryStringValue(string n, IConnectionConfigurationValues s)
    Parameters
    Type Name Description
    string n
    IConnectionConfigurationValues s
    Returns
    Type Description
    string
    | 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
    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

    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)
      • SetQueryString(string, object)
    • Extension Methods
    Back to top Generated by DocFX