Table of Contents

Class RequestParameters<T>

Namespace
Elasticsearch.Net
Assembly
Elasticsearch.Net.dll

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.

public abstract class RequestParameters<T> : IRequestParameters where T : RequestParameters<T>

Type Parameters

T
Inheritance
RequestParameters<T>
Implements
Derived
Inherited Members

Constructors

RequestParameters() 

protected RequestParameters()

Properties

DefaultHttpMethod 

public abstract HttpMethod DefaultHttpMethod { get; }

Property Value

HttpMethod

DeserializationOverride

A method that can be set on the request to take ownership of creating the response object. When set this will be called instead of the internal .Deserialize();

public Func<IApiCallDetails, Stream, object> DeserializationOverride { get; set; }

Property Value

Func<IApiCallDetails, Stream, object>

QueryString

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

public Dictionary<string, object> QueryString { get; set; }

Property Value

Dictionary<string, object>

RequestConfiguration

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

public IRequestConfiguration RequestConfiguration { get; set; }

Property Value

IRequestConfiguration

Methods

ContainsQueryString(string) 

public bool ContainsQueryString(string name)

Parameters

name string

Returns

bool

GetQueryStringValue<TOut>(string)

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

public TOut GetQueryStringValue<TOut>(string name)

Parameters

name string

Returns

TOut

Type Parameters

TOut

GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

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

public string GetResolvedQueryStringValue(string n, IConnectionConfigurationValues s)

Parameters

n string
s IConnectionConfigurationValues

Returns

string

Q(string, object) 

protected void Q(string name, object value)

Parameters

name string
value object

Q<TOut>(string) 

protected TOut Q<TOut>(string name)

Parameters

name string

Returns

TOut

Type Parameters

TOut

SetQueryString(string, object)

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

public void SetQueryString(string name, object value)

Parameters

name string

The query string parameter to add

value object

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